GetContentStorageUnit

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODClipboard

GetContentStorageUnit
The GetContentStorageUnit method returns a reference to the storage unit containing this clipboard object's current content.
ODStorageUnit GetContentStorageUnit ();
return value
A reference to the storage-unit object containing the content of the clipboard.

DISCUSSION
You can read data from or write data to the returned storage unit. You must not cache the returned storage unit; instead you must call this method whenever you need to access the content storage unit.
You must acquire the clipboard focus before calling this method, and relinquish the focus after the data transfer. If you are writing data, you must also call the Clear method before calling this method.
The clipboard object handles the creation and destruction of its content storage unit, so you must neither dispose of nor release the returned storage unit.

EXCEPTIONS

kODErrOutOfMemory
There is not enough memory to complete the operation.

SEE ALSO
The ODClipboard::Clear method (page 89).
The ODClipboard::GetUpdateID method (page 93).
The ODStorageUnit class (page 664).
"Data Configuration" on page 315 in OpenDoc Programmer's Guide.
"Acquiring and Relinquishing the Clipboard Focus" on page 352 in OpenDoc Programmer's Guide.